<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    package org.apache.commons.configuration;<a name="line.17"></a>
<FONT color="green">018</FONT>    <a name="line.18"></a>
<FONT color="green">019</FONT>    import java.io.IOException;<a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.Reader;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.io.Writer;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.LinkedHashMap;<a name="line.22"></a>
<FONT color="green">023</FONT>    import java.util.List;<a name="line.23"></a>
<FONT color="green">024</FONT>    import java.util.Map;<a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.Set;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.commons.configuration.event.ConfigurationEvent;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.commons.configuration.event.ConfigurationListener;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.commons.lang.StringUtils;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    /**<a name="line.31"></a>
<FONT color="green">032</FONT>     * &lt;p&gt;<a name="line.32"></a>
<FONT color="green">033</FONT>     * A helper class used by {@link PropertiesConfiguration} to keep<a name="line.33"></a>
<FONT color="green">034</FONT>     * the layout of a properties file.<a name="line.34"></a>
<FONT color="green">035</FONT>     * &lt;/p&gt;<a name="line.35"></a>
<FONT color="green">036</FONT>     * &lt;p&gt;<a name="line.36"></a>
<FONT color="green">037</FONT>     * Instances of this class are associated with a<a name="line.37"></a>
<FONT color="green">038</FONT>     * {@code PropertiesConfiguration} object. They are responsible for<a name="line.38"></a>
<FONT color="green">039</FONT>     * analyzing properties files and for extracting as much information about the<a name="line.39"></a>
<FONT color="green">040</FONT>     * file layout (e.g. empty lines, comments) as possible. When the properties<a name="line.40"></a>
<FONT color="green">041</FONT>     * file is written back again it should be close to the original.<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;/p&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * &lt;p&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     * The {@code PropertiesConfigurationLayout} object associated with a<a name="line.44"></a>
<FONT color="green">045</FONT>     * {@code PropertiesConfiguration} object can be obtained using the<a name="line.45"></a>
<FONT color="green">046</FONT>     * {@code getLayout()} method of the configuration. Then the methods<a name="line.46"></a>
<FONT color="green">047</FONT>     * provided by this class can be used to alter the properties file's layout.<a name="line.47"></a>
<FONT color="green">048</FONT>     * &lt;/p&gt;<a name="line.48"></a>
<FONT color="green">049</FONT>     * &lt;p&gt;<a name="line.49"></a>
<FONT color="green">050</FONT>     * Implementation note: This is a very simple implementation, which is far away<a name="line.50"></a>
<FONT color="green">051</FONT>     * from being perfect, i.e. the original layout of a properties file won't be<a name="line.51"></a>
<FONT color="green">052</FONT>     * reproduced in all cases. One limitation is that comments for multi-valued<a name="line.52"></a>
<FONT color="green">053</FONT>     * property keys are concatenated. Maybe this implementation can later be<a name="line.53"></a>
<FONT color="green">054</FONT>     * improved.<a name="line.54"></a>
<FONT color="green">055</FONT>     * &lt;/p&gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     * &lt;p&gt;<a name="line.56"></a>
<FONT color="green">057</FONT>     * To get an impression how this class works consider the following properties<a name="line.57"></a>
<FONT color="green">058</FONT>     * file:<a name="line.58"></a>
<FONT color="green">059</FONT>     * &lt;/p&gt;<a name="line.59"></a>
<FONT color="green">060</FONT>     * &lt;p&gt;<a name="line.60"></a>
<FONT color="green">061</FONT>     *<a name="line.61"></a>
<FONT color="green">062</FONT>     * &lt;pre&gt;<a name="line.62"></a>
<FONT color="green">063</FONT>     * # A demo configuration file<a name="line.63"></a>
<FONT color="green">064</FONT>     * # for Demo App 1.42<a name="line.64"></a>
<FONT color="green">065</FONT>     *<a name="line.65"></a>
<FONT color="green">066</FONT>     * # Application name<a name="line.66"></a>
<FONT color="green">067</FONT>     * AppName=Demo App<a name="line.67"></a>
<FONT color="green">068</FONT>     *<a name="line.68"></a>
<FONT color="green">069</FONT>     * # Application vendor<a name="line.69"></a>
<FONT color="green">070</FONT>     * AppVendor=DemoSoft<a name="line.70"></a>
<FONT color="green">071</FONT>     *<a name="line.71"></a>
<FONT color="green">072</FONT>     *<a name="line.72"></a>
<FONT color="green">073</FONT>     * # GUI properties<a name="line.73"></a>
<FONT color="green">074</FONT>     * # Window Color<a name="line.74"></a>
<FONT color="green">075</FONT>     * windowColors=0xFFFFFF,0x000000<a name="line.75"></a>
<FONT color="green">076</FONT>     *<a name="line.76"></a>
<FONT color="green">077</FONT>     * # Include some setting<a name="line.77"></a>
<FONT color="green">078</FONT>     * include=settings.properties<a name="line.78"></a>
<FONT color="green">079</FONT>     * # Another vendor<a name="line.79"></a>
<FONT color="green">080</FONT>     * AppVendor=TestSoft<a name="line.80"></a>
<FONT color="green">081</FONT>     * &lt;/pre&gt;<a name="line.81"></a>
<FONT color="green">082</FONT>     *<a name="line.82"></a>
<FONT color="green">083</FONT>     * &lt;/p&gt;<a name="line.83"></a>
<FONT color="green">084</FONT>     * &lt;p&gt;<a name="line.84"></a>
<FONT color="green">085</FONT>     * For this example the following points are relevant:<a name="line.85"></a>
<FONT color="green">086</FONT>     * &lt;/p&gt;<a name="line.86"></a>
<FONT color="green">087</FONT>     * &lt;p&gt;<a name="line.87"></a>
<FONT color="green">088</FONT>     * &lt;ul&gt;<a name="line.88"></a>
<FONT color="green">089</FONT>     * &lt;li&gt;The first two lines are set as header comment. The header comment is<a name="line.89"></a>
<FONT color="green">090</FONT>     * determined by the last blanc line before the first property definition.&lt;/li&gt;<a name="line.90"></a>
<FONT color="green">091</FONT>     * &lt;li&gt;For the property {@code AppName} one comment line and one<a name="line.91"></a>
<FONT color="green">092</FONT>     * leading blanc line is stored.&lt;/li&gt;<a name="line.92"></a>
<FONT color="green">093</FONT>     * &lt;li&gt;For the property {@code windowColors} two comment lines and two<a name="line.93"></a>
<FONT color="green">094</FONT>     * leading blanc lines are stored.&lt;/li&gt;<a name="line.94"></a>
<FONT color="green">095</FONT>     * &lt;li&gt;Include files is something this class cannot deal with well. When saving<a name="line.95"></a>
<FONT color="green">096</FONT>     * the properties configuration back, the included properties are simply<a name="line.96"></a>
<FONT color="green">097</FONT>     * contained in the original file. The comment before the include property is<a name="line.97"></a>
<FONT color="green">098</FONT>     * skipped.&lt;/li&gt;<a name="line.98"></a>
<FONT color="green">099</FONT>     * &lt;li&gt;For all properties except for {@code AppVendor} the &amp;quot;single<a name="line.99"></a>
<FONT color="green">100</FONT>     * line&amp;quot; flag is set. This is relevant only for {@code windowColors},<a name="line.100"></a>
<FONT color="green">101</FONT>     * which has multiple values defined in one line using the separator character.&lt;/li&gt;<a name="line.101"></a>
<FONT color="green">102</FONT>     * &lt;li&gt;The {@code AppVendor} property appears twice. The comment lines<a name="line.102"></a>
<FONT color="green">103</FONT>     * are concatenated, so that {@code layout.getComment("AppVendor");} will<a name="line.103"></a>
<FONT color="green">104</FONT>     * result in &lt;code&gt;Application vendor&amp;lt;CR&amp;gt;Another vendor&lt;/code&gt;, with<a name="line.104"></a>
<FONT color="green">105</FONT>     * &lt;code&gt;&amp;lt;CR&amp;gt;&lt;/code&gt; meaning the line separator. In addition the<a name="line.105"></a>
<FONT color="green">106</FONT>     * &amp;quot;single line&amp;quot; flag is set to &lt;b&gt;false&lt;/b&gt; for this property. When<a name="line.106"></a>
<FONT color="green">107</FONT>     * the file is saved, two property definitions will be written (in series).&lt;/li&gt;<a name="line.107"></a>
<FONT color="green">108</FONT>     * &lt;/ul&gt;<a name="line.108"></a>
<FONT color="green">109</FONT>     * &lt;/p&gt;<a name="line.109"></a>
<FONT color="green">110</FONT>     *<a name="line.110"></a>
<FONT color="green">111</FONT>     * @author &lt;a<a name="line.111"></a>
<FONT color="green">112</FONT>     * href="http://commons.apache.org/configuration/team-list.html"&gt;Commons<a name="line.112"></a>
<FONT color="green">113</FONT>     * Configuration team&lt;/a&gt;<a name="line.113"></a>
<FONT color="green">114</FONT>     * @version $Id: PropertiesConfigurationLayout.java 1301991 2012-03-17 20:18:02Z sebb $<a name="line.114"></a>
<FONT color="green">115</FONT>     * @since 1.3<a name="line.115"></a>
<FONT color="green">116</FONT>     */<a name="line.116"></a>
<FONT color="green">117</FONT>    public class PropertiesConfigurationLayout implements ConfigurationListener<a name="line.117"></a>
<FONT color="green">118</FONT>    {<a name="line.118"></a>
<FONT color="green">119</FONT>        /** Constant for the line break character. */<a name="line.119"></a>
<FONT color="green">120</FONT>        private static final String CR = "\n";<a name="line.120"></a>
<FONT color="green">121</FONT>    <a name="line.121"></a>
<FONT color="green">122</FONT>        /** Constant for the default comment prefix. */<a name="line.122"></a>
<FONT color="green">123</FONT>        private static final String COMMENT_PREFIX = "# ";<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>        /** Stores the associated configuration object. */<a name="line.125"></a>
<FONT color="green">126</FONT>        private PropertiesConfiguration configuration;<a name="line.126"></a>
<FONT color="green">127</FONT>    <a name="line.127"></a>
<FONT color="green">128</FONT>        /** Stores a map with the contained layout information. */<a name="line.128"></a>
<FONT color="green">129</FONT>        private Map&lt;String, PropertyLayoutData&gt; layoutData;<a name="line.129"></a>
<FONT color="green">130</FONT>    <a name="line.130"></a>
<FONT color="green">131</FONT>        /** Stores the header comment. */<a name="line.131"></a>
<FONT color="green">132</FONT>        private String headerComment;<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>        /** The global separator that will be used for all properties. */<a name="line.134"></a>
<FONT color="green">135</FONT>        private String globalSeparator;<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>        /** The line separator.*/<a name="line.137"></a>
<FONT color="green">138</FONT>        private String lineSeparator;<a name="line.138"></a>
<FONT color="green">139</FONT>    <a name="line.139"></a>
<FONT color="green">140</FONT>        /** A counter for determining nested load calls. */<a name="line.140"></a>
<FONT color="green">141</FONT>        private int loadCounter;<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>        /** Stores the force single line flag. */<a name="line.143"></a>
<FONT color="green">144</FONT>        private boolean forceSingleLine;<a name="line.144"></a>
<FONT color="green">145</FONT>    <a name="line.145"></a>
<FONT color="green">146</FONT>        /**<a name="line.146"></a>
<FONT color="green">147</FONT>         * Creates a new instance of {@code PropertiesConfigurationLayout}<a name="line.147"></a>
<FONT color="green">148</FONT>         * and initializes it with the associated configuration object.<a name="line.148"></a>
<FONT color="green">149</FONT>         *<a name="line.149"></a>
<FONT color="green">150</FONT>         * @param config the configuration (must not be &lt;b&gt;null&lt;/b&gt;)<a name="line.150"></a>
<FONT color="green">151</FONT>         */<a name="line.151"></a>
<FONT color="green">152</FONT>        public PropertiesConfigurationLayout(PropertiesConfiguration config)<a name="line.152"></a>
<FONT color="green">153</FONT>        {<a name="line.153"></a>
<FONT color="green">154</FONT>            this(config, null);<a name="line.154"></a>
<FONT color="green">155</FONT>        }<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>        /**<a name="line.157"></a>
<FONT color="green">158</FONT>         * Creates a new instance of {@code PropertiesConfigurationLayout}<a name="line.158"></a>
<FONT color="green">159</FONT>         * and initializes it with the given configuration object. The data of the<a name="line.159"></a>
<FONT color="green">160</FONT>         * specified layout object is copied.<a name="line.160"></a>
<FONT color="green">161</FONT>         *<a name="line.161"></a>
<FONT color="green">162</FONT>         * @param config the configuration (must not be &lt;b&gt;null&lt;/b&gt;)<a name="line.162"></a>
<FONT color="green">163</FONT>         * @param c the layout object to be copied<a name="line.163"></a>
<FONT color="green">164</FONT>         */<a name="line.164"></a>
<FONT color="green">165</FONT>        public PropertiesConfigurationLayout(PropertiesConfiguration config,<a name="line.165"></a>
<FONT color="green">166</FONT>                PropertiesConfigurationLayout c)<a name="line.166"></a>
<FONT color="green">167</FONT>        {<a name="line.167"></a>
<FONT color="green">168</FONT>            if (config == null)<a name="line.168"></a>
<FONT color="green">169</FONT>            {<a name="line.169"></a>
<FONT color="green">170</FONT>                throw new IllegalArgumentException(<a name="line.170"></a>
<FONT color="green">171</FONT>                        "Configuration must not be null!");<a name="line.171"></a>
<FONT color="green">172</FONT>            }<a name="line.172"></a>
<FONT color="green">173</FONT>            configuration = config;<a name="line.173"></a>
<FONT color="green">174</FONT>            layoutData = new LinkedHashMap&lt;String, PropertyLayoutData&gt;();<a name="line.174"></a>
<FONT color="green">175</FONT>            config.addConfigurationListener(this);<a name="line.175"></a>
<FONT color="green">176</FONT>    <a name="line.176"></a>
<FONT color="green">177</FONT>            if (c != null)<a name="line.177"></a>
<FONT color="green">178</FONT>            {<a name="line.178"></a>
<FONT color="green">179</FONT>                copyFrom(c);<a name="line.179"></a>
<FONT color="green">180</FONT>            }<a name="line.180"></a>
<FONT color="green">181</FONT>        }<a name="line.181"></a>
<FONT color="green">182</FONT>    <a name="line.182"></a>
<FONT color="green">183</FONT>        /**<a name="line.183"></a>
<FONT color="green">184</FONT>         * Returns the associated configuration object.<a name="line.184"></a>
<FONT color="green">185</FONT>         *<a name="line.185"></a>
<FONT color="green">186</FONT>         * @return the associated configuration<a name="line.186"></a>
<FONT color="green">187</FONT>         */<a name="line.187"></a>
<FONT color="green">188</FONT>        public PropertiesConfiguration getConfiguration()<a name="line.188"></a>
<FONT color="green">189</FONT>        {<a name="line.189"></a>
<FONT color="green">190</FONT>            return configuration;<a name="line.190"></a>
<FONT color="green">191</FONT>        }<a name="line.191"></a>
<FONT color="green">192</FONT>    <a name="line.192"></a>
<FONT color="green">193</FONT>        /**<a name="line.193"></a>
<FONT color="green">194</FONT>         * Returns the comment for the specified property key in a canonical form.<a name="line.194"></a>
<FONT color="green">195</FONT>         * &amp;quot;Canonical&amp;quot; means that either all lines start with a comment<a name="line.195"></a>
<FONT color="green">196</FONT>         * character or none. If the {@code commentChar} parameter is &lt;b&gt;false&lt;/b&gt;,<a name="line.196"></a>
<FONT color="green">197</FONT>         * all comment characters are removed, so that the result is only the plain<a name="line.197"></a>
<FONT color="green">198</FONT>         * text of the comment. Otherwise it is ensured that each line of the<a name="line.198"></a>
<FONT color="green">199</FONT>         * comment starts with a comment character. Also, line breaks in the comment<a name="line.199"></a>
<FONT color="green">200</FONT>         * are normalized to the line separator &amp;quot;\n&amp;quot;.<a name="line.200"></a>
<FONT color="green">201</FONT>         *<a name="line.201"></a>
<FONT color="green">202</FONT>         * @param key the key of the property<a name="line.202"></a>
<FONT color="green">203</FONT>         * @param commentChar determines whether all lines should start with comment<a name="line.203"></a>
<FONT color="green">204</FONT>         * characters or not<a name="line.204"></a>
<FONT color="green">205</FONT>         * @return the canonical comment for this key (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.205"></a>
<FONT color="green">206</FONT>         */<a name="line.206"></a>
<FONT color="green">207</FONT>        public String getCanonicalComment(String key, boolean commentChar)<a name="line.207"></a>
<FONT color="green">208</FONT>        {<a name="line.208"></a>
<FONT color="green">209</FONT>            String comment = getComment(key);<a name="line.209"></a>
<FONT color="green">210</FONT>            if (comment == null)<a name="line.210"></a>
<FONT color="green">211</FONT>            {<a name="line.211"></a>
<FONT color="green">212</FONT>                return null;<a name="line.212"></a>
<FONT color="green">213</FONT>            }<a name="line.213"></a>
<FONT color="green">214</FONT>            else<a name="line.214"></a>
<FONT color="green">215</FONT>            {<a name="line.215"></a>
<FONT color="green">216</FONT>                return trimComment(comment, commentChar);<a name="line.216"></a>
<FONT color="green">217</FONT>            }<a name="line.217"></a>
<FONT color="green">218</FONT>        }<a name="line.218"></a>
<FONT color="green">219</FONT>    <a name="line.219"></a>
<FONT color="green">220</FONT>        /**<a name="line.220"></a>
<FONT color="green">221</FONT>         * Returns the comment for the specified property key. The comment is<a name="line.221"></a>
<FONT color="green">222</FONT>         * returned as it was set (either manually by calling<a name="line.222"></a>
<FONT color="green">223</FONT>         * {@code setComment()} or when it was loaded from a properties<a name="line.223"></a>
<FONT color="green">224</FONT>         * file). No modifications are performed.<a name="line.224"></a>
<FONT color="green">225</FONT>         *<a name="line.225"></a>
<FONT color="green">226</FONT>         * @param key the key of the property<a name="line.226"></a>
<FONT color="green">227</FONT>         * @return the comment for this key (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.227"></a>
<FONT color="green">228</FONT>         */<a name="line.228"></a>
<FONT color="green">229</FONT>        public String getComment(String key)<a name="line.229"></a>
<FONT color="green">230</FONT>        {<a name="line.230"></a>
<FONT color="green">231</FONT>            return fetchLayoutData(key).getComment();<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>        /**<a name="line.234"></a>
<FONT color="green">235</FONT>         * Sets the comment for the specified property key. The comment (or its<a name="line.235"></a>
<FONT color="green">236</FONT>         * single lines if it is a multi-line comment) can start with a comment<a name="line.236"></a>
<FONT color="green">237</FONT>         * character. If this is the case, it will be written without changes.<a name="line.237"></a>
<FONT color="green">238</FONT>         * Otherwise a default comment character is added automatically.<a name="line.238"></a>
<FONT color="green">239</FONT>         *<a name="line.239"></a>
<FONT color="green">240</FONT>         * @param key the key of the property<a name="line.240"></a>
<FONT color="green">241</FONT>         * @param comment the comment for this key (can be &lt;b&gt;null&lt;/b&gt;, then the<a name="line.241"></a>
<FONT color="green">242</FONT>         * comment will be removed)<a name="line.242"></a>
<FONT color="green">243</FONT>         */<a name="line.243"></a>
<FONT color="green">244</FONT>        public void setComment(String key, String comment)<a name="line.244"></a>
<FONT color="green">245</FONT>        {<a name="line.245"></a>
<FONT color="green">246</FONT>            fetchLayoutData(key).setComment(comment);<a name="line.246"></a>
<FONT color="green">247</FONT>        }<a name="line.247"></a>
<FONT color="green">248</FONT>    <a name="line.248"></a>
<FONT color="green">249</FONT>        /**<a name="line.249"></a>
<FONT color="green">250</FONT>         * Returns the number of blanc lines before this property key. If this key<a name="line.250"></a>
<FONT color="green">251</FONT>         * does not exist, 0 will be returned.<a name="line.251"></a>
<FONT color="green">252</FONT>         *<a name="line.252"></a>
<FONT color="green">253</FONT>         * @param key the property key<a name="line.253"></a>
<FONT color="green">254</FONT>         * @return the number of blanc lines before the property definition for this<a name="line.254"></a>
<FONT color="green">255</FONT>         * key<a name="line.255"></a>
<FONT color="green">256</FONT>         */<a name="line.256"></a>
<FONT color="green">257</FONT>        public int getBlancLinesBefore(String key)<a name="line.257"></a>
<FONT color="green">258</FONT>        {<a name="line.258"></a>
<FONT color="green">259</FONT>            return fetchLayoutData(key).getBlancLines();<a name="line.259"></a>
<FONT color="green">260</FONT>        }<a name="line.260"></a>
<FONT color="green">261</FONT>    <a name="line.261"></a>
<FONT color="green">262</FONT>        /**<a name="line.262"></a>
<FONT color="green">263</FONT>         * Sets the number of blanc lines before the given property key. This can be<a name="line.263"></a>
<FONT color="green">264</FONT>         * used for a logical grouping of properties.<a name="line.264"></a>
<FONT color="green">265</FONT>         *<a name="line.265"></a>
<FONT color="green">266</FONT>         * @param key the property key<a name="line.266"></a>
<FONT color="green">267</FONT>         * @param number the number of blanc lines to add before this property<a name="line.267"></a>
<FONT color="green">268</FONT>         * definition<a name="line.268"></a>
<FONT color="green">269</FONT>         */<a name="line.269"></a>
<FONT color="green">270</FONT>        public void setBlancLinesBefore(String key, int number)<a name="line.270"></a>
<FONT color="green">271</FONT>        {<a name="line.271"></a>
<FONT color="green">272</FONT>            fetchLayoutData(key).setBlancLines(number);<a name="line.272"></a>
<FONT color="green">273</FONT>        }<a name="line.273"></a>
<FONT color="green">274</FONT>    <a name="line.274"></a>
<FONT color="green">275</FONT>        /**<a name="line.275"></a>
<FONT color="green">276</FONT>         * Returns the header comment of the represented properties file in a<a name="line.276"></a>
<FONT color="green">277</FONT>         * canonical form. With the {@code commentChar} parameter it can be<a name="line.277"></a>
<FONT color="green">278</FONT>         * specified whether comment characters should be stripped or be always<a name="line.278"></a>
<FONT color="green">279</FONT>         * present.<a name="line.279"></a>
<FONT color="green">280</FONT>         *<a name="line.280"></a>
<FONT color="green">281</FONT>         * @param commentChar determines the presence of comment characters<a name="line.281"></a>
<FONT color="green">282</FONT>         * @return the header comment (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.282"></a>
<FONT color="green">283</FONT>         */<a name="line.283"></a>
<FONT color="green">284</FONT>        public String getCanonicalHeaderComment(boolean commentChar)<a name="line.284"></a>
<FONT color="green">285</FONT>        {<a name="line.285"></a>
<FONT color="green">286</FONT>            return (getHeaderComment() == null) ? null : trimComment(<a name="line.286"></a>
<FONT color="green">287</FONT>                    getHeaderComment(), commentChar);<a name="line.287"></a>
<FONT color="green">288</FONT>        }<a name="line.288"></a>
<FONT color="green">289</FONT>    <a name="line.289"></a>
<FONT color="green">290</FONT>        /**<a name="line.290"></a>
<FONT color="green">291</FONT>         * Returns the header comment of the represented properties file. This<a name="line.291"></a>
<FONT color="green">292</FONT>         * method returns the header comment exactly as it was set using<a name="line.292"></a>
<FONT color="green">293</FONT>         * {@code setHeaderComment()} or extracted from the loaded properties<a name="line.293"></a>
<FONT color="green">294</FONT>         * file.<a name="line.294"></a>
<FONT color="green">295</FONT>         *<a name="line.295"></a>
<FONT color="green">296</FONT>         * @return the header comment (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.296"></a>
<FONT color="green">297</FONT>         */<a name="line.297"></a>
<FONT color="green">298</FONT>        public String getHeaderComment()<a name="line.298"></a>
<FONT color="green">299</FONT>        {<a name="line.299"></a>
<FONT color="green">300</FONT>            return headerComment;<a name="line.300"></a>
<FONT color="green">301</FONT>        }<a name="line.301"></a>
<FONT color="green">302</FONT>    <a name="line.302"></a>
<FONT color="green">303</FONT>        /**<a name="line.303"></a>
<FONT color="green">304</FONT>         * Sets the header comment for the represented properties file. This comment<a name="line.304"></a>
<FONT color="green">305</FONT>         * will be output on top of the file.<a name="line.305"></a>
<FONT color="green">306</FONT>         *<a name="line.306"></a>
<FONT color="green">307</FONT>         * @param comment the comment<a name="line.307"></a>
<FONT color="green">308</FONT>         */<a name="line.308"></a>
<FONT color="green">309</FONT>        public void setHeaderComment(String comment)<a name="line.309"></a>
<FONT color="green">310</FONT>        {<a name="line.310"></a>
<FONT color="green">311</FONT>            headerComment = comment;<a name="line.311"></a>
<FONT color="green">312</FONT>        }<a name="line.312"></a>
<FONT color="green">313</FONT>    <a name="line.313"></a>
<FONT color="green">314</FONT>        /**<a name="line.314"></a>
<FONT color="green">315</FONT>         * Returns a flag whether the specified property is defined on a single<a name="line.315"></a>
<FONT color="green">316</FONT>         * line. This is meaningful only if this property has multiple values.<a name="line.316"></a>
<FONT color="green">317</FONT>         *<a name="line.317"></a>
<FONT color="green">318</FONT>         * @param key the property key<a name="line.318"></a>
<FONT color="green">319</FONT>         * @return a flag if this property is defined on a single line<a name="line.319"></a>
<FONT color="green">320</FONT>         */<a name="line.320"></a>
<FONT color="green">321</FONT>        public boolean isSingleLine(String key)<a name="line.321"></a>
<FONT color="green">322</FONT>        {<a name="line.322"></a>
<FONT color="green">323</FONT>            return fetchLayoutData(key).isSingleLine();<a name="line.323"></a>
<FONT color="green">324</FONT>        }<a name="line.324"></a>
<FONT color="green">325</FONT>    <a name="line.325"></a>
<FONT color="green">326</FONT>        /**<a name="line.326"></a>
<FONT color="green">327</FONT>         * Sets the &amp;quot;single line flag&amp;quot; for the specified property key.<a name="line.327"></a>
<FONT color="green">328</FONT>         * This flag is evaluated if the property has multiple values (i.e. if it is<a name="line.328"></a>
<FONT color="green">329</FONT>         * a list property). In this case, if the flag is set, all values will be<a name="line.329"></a>
<FONT color="green">330</FONT>         * written in a single property definition using the list delimiter as<a name="line.330"></a>
<FONT color="green">331</FONT>         * separator. Otherwise multiple lines will be written for this property,<a name="line.331"></a>
<FONT color="green">332</FONT>         * each line containing one property value.<a name="line.332"></a>
<FONT color="green">333</FONT>         *<a name="line.333"></a>
<FONT color="green">334</FONT>         * @param key the property key<a name="line.334"></a>
<FONT color="green">335</FONT>         * @param f the single line flag<a name="line.335"></a>
<FONT color="green">336</FONT>         */<a name="line.336"></a>
<FONT color="green">337</FONT>        public void setSingleLine(String key, boolean f)<a name="line.337"></a>
<FONT color="green">338</FONT>        {<a name="line.338"></a>
<FONT color="green">339</FONT>            fetchLayoutData(key).setSingleLine(f);<a name="line.339"></a>
<FONT color="green">340</FONT>        }<a name="line.340"></a>
<FONT color="green">341</FONT>    <a name="line.341"></a>
<FONT color="green">342</FONT>        /**<a name="line.342"></a>
<FONT color="green">343</FONT>         * Returns the &amp;quot;force single line&amp;quot; flag.<a name="line.343"></a>
<FONT color="green">344</FONT>         *<a name="line.344"></a>
<FONT color="green">345</FONT>         * @return the force single line flag<a name="line.345"></a>
<FONT color="green">346</FONT>         * @see #setForceSingleLine(boolean)<a name="line.346"></a>
<FONT color="green">347</FONT>         */<a name="line.347"></a>
<FONT color="green">348</FONT>        public boolean isForceSingleLine()<a name="line.348"></a>
<FONT color="green">349</FONT>        {<a name="line.349"></a>
<FONT color="green">350</FONT>            return forceSingleLine;<a name="line.350"></a>
<FONT color="green">351</FONT>        }<a name="line.351"></a>
<FONT color="green">352</FONT>    <a name="line.352"></a>
<FONT color="green">353</FONT>        /**<a name="line.353"></a>
<FONT color="green">354</FONT>         * Sets the &amp;quot;force single line&amp;quot; flag. If this flag is set, all<a name="line.354"></a>
<FONT color="green">355</FONT>         * properties with multiple values are written on single lines. This mode<a name="line.355"></a>
<FONT color="green">356</FONT>         * provides more compatibility with {@code java.lang.Properties},<a name="line.356"></a>
<FONT color="green">357</FONT>         * which cannot deal with multiple definitions of a single property. This<a name="line.357"></a>
<FONT color="green">358</FONT>         * mode has no effect if the list delimiter parsing is disabled.<a name="line.358"></a>
<FONT color="green">359</FONT>         *<a name="line.359"></a>
<FONT color="green">360</FONT>         * @param f the force single line flag<a name="line.360"></a>
<FONT color="green">361</FONT>         */<a name="line.361"></a>
<FONT color="green">362</FONT>        public void setForceSingleLine(boolean f)<a name="line.362"></a>
<FONT color="green">363</FONT>        {<a name="line.363"></a>
<FONT color="green">364</FONT>            forceSingleLine = f;<a name="line.364"></a>
<FONT color="green">365</FONT>        }<a name="line.365"></a>
<FONT color="green">366</FONT>    <a name="line.366"></a>
<FONT color="green">367</FONT>        /**<a name="line.367"></a>
<FONT color="green">368</FONT>         * Returns the separator for the property with the given key.<a name="line.368"></a>
<FONT color="green">369</FONT>         *<a name="line.369"></a>
<FONT color="green">370</FONT>         * @param key the property key<a name="line.370"></a>
<FONT color="green">371</FONT>         * @return the property separator for this property<a name="line.371"></a>
<FONT color="green">372</FONT>         * @since 1.7<a name="line.372"></a>
<FONT color="green">373</FONT>         */<a name="line.373"></a>
<FONT color="green">374</FONT>        public String getSeparator(String key)<a name="line.374"></a>
<FONT color="green">375</FONT>        {<a name="line.375"></a>
<FONT color="green">376</FONT>            return fetchLayoutData(key).getSeparator();<a name="line.376"></a>
<FONT color="green">377</FONT>        }<a name="line.377"></a>
<FONT color="green">378</FONT>    <a name="line.378"></a>
<FONT color="green">379</FONT>        /**<a name="line.379"></a>
<FONT color="green">380</FONT>         * Sets the separator to be used for the property with the given key. The<a name="line.380"></a>
<FONT color="green">381</FONT>         * separator is the string between the property key and its value. For new<a name="line.381"></a>
<FONT color="green">382</FONT>         * properties &amp;quot; = &amp;quot; is used. When a properties file is read, the<a name="line.382"></a>
<FONT color="green">383</FONT>         * layout tries to determine the separator for each property. With this<a name="line.383"></a>
<FONT color="green">384</FONT>         * method the separator can be changed. To be compatible with the properties<a name="line.384"></a>
<FONT color="green">385</FONT>         * format only the characters {@code =} and {@code :} (with or<a name="line.385"></a>
<FONT color="green">386</FONT>         * without whitespace) should be used, but this method does not enforce this<a name="line.386"></a>
<FONT color="green">387</FONT>         * - it accepts arbitrary strings. If the key refers to a property with<a name="line.387"></a>
<FONT color="green">388</FONT>         * multiple values that are written on multiple lines, this separator will<a name="line.388"></a>
<FONT color="green">389</FONT>         * be used on all lines.<a name="line.389"></a>
<FONT color="green">390</FONT>         *<a name="line.390"></a>
<FONT color="green">391</FONT>         * @param key the key for the property<a name="line.391"></a>
<FONT color="green">392</FONT>         * @param sep the separator to be used for this property<a name="line.392"></a>
<FONT color="green">393</FONT>         * @since 1.7<a name="line.393"></a>
<FONT color="green">394</FONT>         */<a name="line.394"></a>
<FONT color="green">395</FONT>        public void setSeparator(String key, String sep)<a name="line.395"></a>
<FONT color="green">396</FONT>        {<a name="line.396"></a>
<FONT color="green">397</FONT>            fetchLayoutData(key).setSeparator(sep);<a name="line.397"></a>
<FONT color="green">398</FONT>        }<a name="line.398"></a>
<FONT color="green">399</FONT>    <a name="line.399"></a>
<FONT color="green">400</FONT>        /**<a name="line.400"></a>
<FONT color="green">401</FONT>         * Returns the global separator.<a name="line.401"></a>
<FONT color="green">402</FONT>         *<a name="line.402"></a>
<FONT color="green">403</FONT>         * @return the global properties separator<a name="line.403"></a>
<FONT color="green">404</FONT>         * @since 1.7<a name="line.404"></a>
<FONT color="green">405</FONT>         */<a name="line.405"></a>
<FONT color="green">406</FONT>        public String getGlobalSeparator()<a name="line.406"></a>
<FONT color="green">407</FONT>        {<a name="line.407"></a>
<FONT color="green">408</FONT>            return globalSeparator;<a name="line.408"></a>
<FONT color="green">409</FONT>        }<a name="line.409"></a>
<FONT color="green">410</FONT>    <a name="line.410"></a>
<FONT color="green">411</FONT>        /**<a name="line.411"></a>
<FONT color="green">412</FONT>         * Sets the global separator for properties. With this method a separator<a name="line.412"></a>
<FONT color="green">413</FONT>         * can be set that will be used for all properties when writing the<a name="line.413"></a>
<FONT color="green">414</FONT>         * configuration. This is an easy way of determining the properties<a name="line.414"></a>
<FONT color="green">415</FONT>         * separator globally. To be compatible with the properties format only the<a name="line.415"></a>
<FONT color="green">416</FONT>         * characters {@code =} and {@code :} (with or without whitespace)<a name="line.416"></a>
<FONT color="green">417</FONT>         * should be used, but this method does not enforce this - it accepts<a name="line.417"></a>
<FONT color="green">418</FONT>         * arbitrary strings. If the global separator is set to &lt;b&gt;null&lt;/b&gt;,<a name="line.418"></a>
<FONT color="green">419</FONT>         * property separators are not changed. This is the default behavior as it<a name="line.419"></a>
<FONT color="green">420</FONT>         * produces results that are closer to the original properties file.<a name="line.420"></a>
<FONT color="green">421</FONT>         *<a name="line.421"></a>
<FONT color="green">422</FONT>         * @param globalSeparator the separator to be used for all properties<a name="line.422"></a>
<FONT color="green">423</FONT>         * @since 1.7<a name="line.423"></a>
<FONT color="green">424</FONT>         */<a name="line.424"></a>
<FONT color="green">425</FONT>        public void setGlobalSeparator(String globalSeparator)<a name="line.425"></a>
<FONT color="green">426</FONT>        {<a name="line.426"></a>
<FONT color="green">427</FONT>            this.globalSeparator = globalSeparator;<a name="line.427"></a>
<FONT color="green">428</FONT>        }<a name="line.428"></a>
<FONT color="green">429</FONT>    <a name="line.429"></a>
<FONT color="green">430</FONT>        /**<a name="line.430"></a>
<FONT color="green">431</FONT>         * Returns the line separator.<a name="line.431"></a>
<FONT color="green">432</FONT>         *<a name="line.432"></a>
<FONT color="green">433</FONT>         * @return the line separator<a name="line.433"></a>
<FONT color="green">434</FONT>         * @since 1.7<a name="line.434"></a>
<FONT color="green">435</FONT>         */<a name="line.435"></a>
<FONT color="green">436</FONT>        public String getLineSeparator()<a name="line.436"></a>
<FONT color="green">437</FONT>        {<a name="line.437"></a>
<FONT color="green">438</FONT>            return lineSeparator;<a name="line.438"></a>
<FONT color="green">439</FONT>        }<a name="line.439"></a>
<FONT color="green">440</FONT>    <a name="line.440"></a>
<FONT color="green">441</FONT>        /**<a name="line.441"></a>
<FONT color="green">442</FONT>         * Sets the line separator. When writing the properties configuration, all<a name="line.442"></a>
<FONT color="green">443</FONT>         * lines are terminated with this separator. If no separator was set, the<a name="line.443"></a>
<FONT color="green">444</FONT>         * platform-specific default line separator is used.<a name="line.444"></a>
<FONT color="green">445</FONT>         *<a name="line.445"></a>
<FONT color="green">446</FONT>         * @param lineSeparator the line separator<a name="line.446"></a>
<FONT color="green">447</FONT>         * @since 1.7<a name="line.447"></a>
<FONT color="green">448</FONT>         */<a name="line.448"></a>
<FONT color="green">449</FONT>        public void setLineSeparator(String lineSeparator)<a name="line.449"></a>
<FONT color="green">450</FONT>        {<a name="line.450"></a>
<FONT color="green">451</FONT>            this.lineSeparator = lineSeparator;<a name="line.451"></a>
<FONT color="green">452</FONT>        }<a name="line.452"></a>
<FONT color="green">453</FONT>    <a name="line.453"></a>
<FONT color="green">454</FONT>        /**<a name="line.454"></a>
<FONT color="green">455</FONT>         * Returns a set with all property keys managed by this object.<a name="line.455"></a>
<FONT color="green">456</FONT>         *<a name="line.456"></a>
<FONT color="green">457</FONT>         * @return a set with all contained property keys<a name="line.457"></a>
<FONT color="green">458</FONT>         */<a name="line.458"></a>
<FONT color="green">459</FONT>        public Set&lt;String&gt; getKeys()<a name="line.459"></a>
<FONT color="green">460</FONT>        {<a name="line.460"></a>
<FONT color="green">461</FONT>            return layoutData.keySet();<a name="line.461"></a>
<FONT color="green">462</FONT>        }<a name="line.462"></a>
<FONT color="green">463</FONT>    <a name="line.463"></a>
<FONT color="green">464</FONT>        /**<a name="line.464"></a>
<FONT color="green">465</FONT>         * Reads a properties file and stores its internal structure. The found<a name="line.465"></a>
<FONT color="green">466</FONT>         * properties will be added to the associated configuration object.<a name="line.466"></a>
<FONT color="green">467</FONT>         *<a name="line.467"></a>
<FONT color="green">468</FONT>         * @param in the reader to the properties file<a name="line.468"></a>
<FONT color="green">469</FONT>         * @throws ConfigurationException if an error occurs<a name="line.469"></a>
<FONT color="green">470</FONT>         */<a name="line.470"></a>
<FONT color="green">471</FONT>        public void load(Reader in) throws ConfigurationException<a name="line.471"></a>
<FONT color="green">472</FONT>        {<a name="line.472"></a>
<FONT color="green">473</FONT>            if (++loadCounter == 1)<a name="line.473"></a>
<FONT color="green">474</FONT>            {<a name="line.474"></a>
<FONT color="green">475</FONT>                getConfiguration().removeConfigurationListener(this);<a name="line.475"></a>
<FONT color="green">476</FONT>            }<a name="line.476"></a>
<FONT color="green">477</FONT>            PropertiesConfiguration.PropertiesReader reader = getConfiguration()<a name="line.477"></a>
<FONT color="green">478</FONT>                    .getIOFactory().createPropertiesReader(in,<a name="line.478"></a>
<FONT color="green">479</FONT>                            getConfiguration().getListDelimiter());<a name="line.479"></a>
<FONT color="green">480</FONT>    <a name="line.480"></a>
<FONT color="green">481</FONT>            try<a name="line.481"></a>
<FONT color="green">482</FONT>            {<a name="line.482"></a>
<FONT color="green">483</FONT>                while (reader.nextProperty())<a name="line.483"></a>
<FONT color="green">484</FONT>                {<a name="line.484"></a>
<FONT color="green">485</FONT>                    if (getConfiguration().propertyLoaded(reader.getPropertyName(),<a name="line.485"></a>
<FONT color="green">486</FONT>                            reader.getPropertyValue()))<a name="line.486"></a>
<FONT color="green">487</FONT>                    {<a name="line.487"></a>
<FONT color="green">488</FONT>                        boolean contained = layoutData.containsKey(reader<a name="line.488"></a>
<FONT color="green">489</FONT>                                .getPropertyName());<a name="line.489"></a>
<FONT color="green">490</FONT>                        int blancLines = 0;<a name="line.490"></a>
<FONT color="green">491</FONT>                        int idx = checkHeaderComment(reader.getCommentLines());<a name="line.491"></a>
<FONT color="green">492</FONT>                        while (idx &lt; reader.getCommentLines().size()<a name="line.492"></a>
<FONT color="green">493</FONT>                                &amp;&amp; reader.getCommentLines().get(idx).length() &lt; 1)<a name="line.493"></a>
<FONT color="green">494</FONT>                        {<a name="line.494"></a>
<FONT color="green">495</FONT>                            idx++;<a name="line.495"></a>
<FONT color="green">496</FONT>                            blancLines++;<a name="line.496"></a>
<FONT color="green">497</FONT>                        }<a name="line.497"></a>
<FONT color="green">498</FONT>                        String comment = extractComment(reader.getCommentLines(),<a name="line.498"></a>
<FONT color="green">499</FONT>                                idx, reader.getCommentLines().size() - 1);<a name="line.499"></a>
<FONT color="green">500</FONT>                        PropertyLayoutData data = fetchLayoutData(reader<a name="line.500"></a>
<FONT color="green">501</FONT>                                .getPropertyName());<a name="line.501"></a>
<FONT color="green">502</FONT>                        if (contained)<a name="line.502"></a>
<FONT color="green">503</FONT>                        {<a name="line.503"></a>
<FONT color="green">504</FONT>                            data.addComment(comment);<a name="line.504"></a>
<FONT color="green">505</FONT>                            data.setSingleLine(false);<a name="line.505"></a>
<FONT color="green">506</FONT>                        }<a name="line.506"></a>
<FONT color="green">507</FONT>                        else<a name="line.507"></a>
<FONT color="green">508</FONT>                        {<a name="line.508"></a>
<FONT color="green">509</FONT>                            data.setComment(comment);<a name="line.509"></a>
<FONT color="green">510</FONT>                            data.setBlancLines(blancLines);<a name="line.510"></a>
<FONT color="green">511</FONT>                            data.setSeparator(reader.getPropertySeparator());<a name="line.511"></a>
<FONT color="green">512</FONT>                        }<a name="line.512"></a>
<FONT color="green">513</FONT>                    }<a name="line.513"></a>
<FONT color="green">514</FONT>                }<a name="line.514"></a>
<FONT color="green">515</FONT>            }<a name="line.515"></a>
<FONT color="green">516</FONT>            catch (IOException ioex)<a name="line.516"></a>
<FONT color="green">517</FONT>            {<a name="line.517"></a>
<FONT color="green">518</FONT>                throw new ConfigurationException(ioex);<a name="line.518"></a>
<FONT color="green">519</FONT>            }<a name="line.519"></a>
<FONT color="green">520</FONT>            finally<a name="line.520"></a>
<FONT color="green">521</FONT>            {<a name="line.521"></a>
<FONT color="green">522</FONT>                if (--loadCounter == 0)<a name="line.522"></a>
<FONT color="green">523</FONT>                {<a name="line.523"></a>
<FONT color="green">524</FONT>                    getConfiguration().addConfigurationListener(this);<a name="line.524"></a>
<FONT color="green">525</FONT>                }<a name="line.525"></a>
<FONT color="green">526</FONT>            }<a name="line.526"></a>
<FONT color="green">527</FONT>        }<a name="line.527"></a>
<FONT color="green">528</FONT>    <a name="line.528"></a>
<FONT color="green">529</FONT>        /**<a name="line.529"></a>
<FONT color="green">530</FONT>         * Writes the properties file to the given writer, preserving as much of its<a name="line.530"></a>
<FONT color="green">531</FONT>         * structure as possible.<a name="line.531"></a>
<FONT color="green">532</FONT>         *<a name="line.532"></a>
<FONT color="green">533</FONT>         * @param out the writer<a name="line.533"></a>
<FONT color="green">534</FONT>         * @throws ConfigurationException if an error occurs<a name="line.534"></a>
<FONT color="green">535</FONT>         */<a name="line.535"></a>
<FONT color="green">536</FONT>        public void save(Writer out) throws ConfigurationException<a name="line.536"></a>
<FONT color="green">537</FONT>        {<a name="line.537"></a>
<FONT color="green">538</FONT>            try<a name="line.538"></a>
<FONT color="green">539</FONT>            {<a name="line.539"></a>
<FONT color="green">540</FONT>                char delimiter = getConfiguration().isDelimiterParsingDisabled() ? 0<a name="line.540"></a>
<FONT color="green">541</FONT>                        : getConfiguration().getListDelimiter();<a name="line.541"></a>
<FONT color="green">542</FONT>                PropertiesConfiguration.PropertiesWriter writer = getConfiguration()<a name="line.542"></a>
<FONT color="green">543</FONT>                        .getIOFactory().createPropertiesWriter(out, delimiter);<a name="line.543"></a>
<FONT color="green">544</FONT>                writer.setGlobalSeparator(getGlobalSeparator());<a name="line.544"></a>
<FONT color="green">545</FONT>                if (getLineSeparator() != null)<a name="line.545"></a>
<FONT color="green">546</FONT>                {<a name="line.546"></a>
<FONT color="green">547</FONT>                    writer.setLineSeparator(getLineSeparator());<a name="line.547"></a>
<FONT color="green">548</FONT>                }<a name="line.548"></a>
<FONT color="green">549</FONT>    <a name="line.549"></a>
<FONT color="green">550</FONT>                if (headerComment != null)<a name="line.550"></a>
<FONT color="green">551</FONT>                {<a name="line.551"></a>
<FONT color="green">552</FONT>                    writeComment(writer, getCanonicalHeaderComment(true));<a name="line.552"></a>
<FONT color="green">553</FONT>                    writer.writeln(null);<a name="line.553"></a>
<FONT color="green">554</FONT>                }<a name="line.554"></a>
<FONT color="green">555</FONT>    <a name="line.555"></a>
<FONT color="green">556</FONT>                for (String key : layoutData.keySet())<a name="line.556"></a>
<FONT color="green">557</FONT>                {<a name="line.557"></a>
<FONT color="green">558</FONT>                    if (getConfiguration().containsKey(key))<a name="line.558"></a>
<FONT color="green">559</FONT>                    {<a name="line.559"></a>
<FONT color="green">560</FONT>    <a name="line.560"></a>
<FONT color="green">561</FONT>                        // Output blank lines before property<a name="line.561"></a>
<FONT color="green">562</FONT>                        for (int i = 0; i &lt; getBlancLinesBefore(key); i++)<a name="line.562"></a>
<FONT color="green">563</FONT>                        {<a name="line.563"></a>
<FONT color="green">564</FONT>                            writer.writeln(null);<a name="line.564"></a>
<FONT color="green">565</FONT>                        }<a name="line.565"></a>
<FONT color="green">566</FONT>    <a name="line.566"></a>
<FONT color="green">567</FONT>                        // Output the comment<a name="line.567"></a>
<FONT color="green">568</FONT>                        writeComment(writer, getCanonicalComment(key, true));<a name="line.568"></a>
<FONT color="green">569</FONT>    <a name="line.569"></a>
<FONT color="green">570</FONT>                        // Output the property and its value<a name="line.570"></a>
<FONT color="green">571</FONT>                        boolean singleLine = (isForceSingleLine() || isSingleLine(key))<a name="line.571"></a>
<FONT color="green">572</FONT>                                &amp;&amp; !getConfiguration().isDelimiterParsingDisabled();<a name="line.572"></a>
<FONT color="green">573</FONT>                        writer.setCurrentSeparator(getSeparator(key));<a name="line.573"></a>
<FONT color="green">574</FONT>                        writer.writeProperty(key, getConfiguration().getProperty(<a name="line.574"></a>
<FONT color="green">575</FONT>                                key), singleLine);<a name="line.575"></a>
<FONT color="green">576</FONT>                    }<a name="line.576"></a>
<FONT color="green">577</FONT>                }<a name="line.577"></a>
<FONT color="green">578</FONT>                writer.flush();<a name="line.578"></a>
<FONT color="green">579</FONT>            }<a name="line.579"></a>
<FONT color="green">580</FONT>            catch (IOException ioex)<a name="line.580"></a>
<FONT color="green">581</FONT>            {<a name="line.581"></a>
<FONT color="green">582</FONT>                throw new ConfigurationException(ioex);<a name="line.582"></a>
<FONT color="green">583</FONT>            }<a name="line.583"></a>
<FONT color="green">584</FONT>        }<a name="line.584"></a>
<FONT color="green">585</FONT>    <a name="line.585"></a>
<FONT color="green">586</FONT>        /**<a name="line.586"></a>
<FONT color="green">587</FONT>         * The event listener callback. Here event notifications of the<a name="line.587"></a>
<FONT color="green">588</FONT>         * configuration object are processed to update the layout object properly.<a name="line.588"></a>
<FONT color="green">589</FONT>         *<a name="line.589"></a>
<FONT color="green">590</FONT>         * @param event the event object<a name="line.590"></a>
<FONT color="green">591</FONT>         */<a name="line.591"></a>
<FONT color="green">592</FONT>        public void configurationChanged(ConfigurationEvent event)<a name="line.592"></a>
<FONT color="green">593</FONT>        {<a name="line.593"></a>
<FONT color="green">594</FONT>            if (event.isBeforeUpdate())<a name="line.594"></a>
<FONT color="green">595</FONT>            {<a name="line.595"></a>
<FONT color="green">596</FONT>                if (AbstractFileConfiguration.EVENT_RELOAD == event.getType())<a name="line.596"></a>
<FONT color="green">597</FONT>                {<a name="line.597"></a>
<FONT color="green">598</FONT>                    clear();<a name="line.598"></a>
<FONT color="green">599</FONT>                }<a name="line.599"></a>
<FONT color="green">600</FONT>            }<a name="line.600"></a>
<FONT color="green">601</FONT>    <a name="line.601"></a>
<FONT color="green">602</FONT>            else<a name="line.602"></a>
<FONT color="green">603</FONT>            {<a name="line.603"></a>
<FONT color="green">604</FONT>                switch (event.getType())<a name="line.604"></a>
<FONT color="green">605</FONT>                {<a name="line.605"></a>
<FONT color="green">606</FONT>                case AbstractConfiguration.EVENT_ADD_PROPERTY:<a name="line.606"></a>
<FONT color="green">607</FONT>                    boolean contained = layoutData.containsKey(event<a name="line.607"></a>
<FONT color="green">608</FONT>                            .getPropertyName());<a name="line.608"></a>
<FONT color="green">609</FONT>                    PropertyLayoutData data = fetchLayoutData(event<a name="line.609"></a>
<FONT color="green">610</FONT>                            .getPropertyName());<a name="line.610"></a>
<FONT color="green">611</FONT>                    data.setSingleLine(!contained);<a name="line.611"></a>
<FONT color="green">612</FONT>                    break;<a name="line.612"></a>
<FONT color="green">613</FONT>                case AbstractConfiguration.EVENT_CLEAR_PROPERTY:<a name="line.613"></a>
<FONT color="green">614</FONT>                    layoutData.remove(event.getPropertyName());<a name="line.614"></a>
<FONT color="green">615</FONT>                    break;<a name="line.615"></a>
<FONT color="green">616</FONT>                case AbstractConfiguration.EVENT_CLEAR:<a name="line.616"></a>
<FONT color="green">617</FONT>                    clear();<a name="line.617"></a>
<FONT color="green">618</FONT>                    break;<a name="line.618"></a>
<FONT color="green">619</FONT>                case AbstractConfiguration.EVENT_SET_PROPERTY:<a name="line.619"></a>
<FONT color="green">620</FONT>                    fetchLayoutData(event.getPropertyName());<a name="line.620"></a>
<FONT color="green">621</FONT>                    break;<a name="line.621"></a>
<FONT color="green">622</FONT>                }<a name="line.622"></a>
<FONT color="green">623</FONT>            }<a name="line.623"></a>
<FONT color="green">624</FONT>        }<a name="line.624"></a>
<FONT color="green">625</FONT>    <a name="line.625"></a>
<FONT color="green">626</FONT>        /**<a name="line.626"></a>
<FONT color="green">627</FONT>         * Returns a layout data object for the specified key. If this is a new key,<a name="line.627"></a>
<FONT color="green">628</FONT>         * a new object is created and initialized with default values.<a name="line.628"></a>
<FONT color="green">629</FONT>         *<a name="line.629"></a>
<FONT color="green">630</FONT>         * @param key the key<a name="line.630"></a>
<FONT color="green">631</FONT>         * @return the corresponding layout data object<a name="line.631"></a>
<FONT color="green">632</FONT>         */<a name="line.632"></a>
<FONT color="green">633</FONT>        private PropertyLayoutData fetchLayoutData(String key)<a name="line.633"></a>
<FONT color="green">634</FONT>        {<a name="line.634"></a>
<FONT color="green">635</FONT>            if (key == null)<a name="line.635"></a>
<FONT color="green">636</FONT>            {<a name="line.636"></a>
<FONT color="green">637</FONT>                throw new IllegalArgumentException("Property key must not be null!");<a name="line.637"></a>
<FONT color="green">638</FONT>            }<a name="line.638"></a>
<FONT color="green">639</FONT>    <a name="line.639"></a>
<FONT color="green">640</FONT>            PropertyLayoutData data = layoutData.get(key);<a name="line.640"></a>
<FONT color="green">641</FONT>            if (data == null)<a name="line.641"></a>
<FONT color="green">642</FONT>            {<a name="line.642"></a>
<FONT color="green">643</FONT>                data = new PropertyLayoutData();<a name="line.643"></a>
<FONT color="green">644</FONT>                data.setSingleLine(true);<a name="line.644"></a>
<FONT color="green">645</FONT>                layoutData.put(key, data);<a name="line.645"></a>
<FONT color="green">646</FONT>            }<a name="line.646"></a>
<FONT color="green">647</FONT>    <a name="line.647"></a>
<FONT color="green">648</FONT>            return data;<a name="line.648"></a>
<FONT color="green">649</FONT>        }<a name="line.649"></a>
<FONT color="green">650</FONT>    <a name="line.650"></a>
<FONT color="green">651</FONT>        /**<a name="line.651"></a>
<FONT color="green">652</FONT>         * Removes all content from this layout object.<a name="line.652"></a>
<FONT color="green">653</FONT>         */<a name="line.653"></a>
<FONT color="green">654</FONT>        private void clear()<a name="line.654"></a>
<FONT color="green">655</FONT>        {<a name="line.655"></a>
<FONT color="green">656</FONT>            layoutData.clear();<a name="line.656"></a>
<FONT color="green">657</FONT>            setHeaderComment(null);<a name="line.657"></a>
<FONT color="green">658</FONT>        }<a name="line.658"></a>
<FONT color="green">659</FONT>    <a name="line.659"></a>
<FONT color="green">660</FONT>        /**<a name="line.660"></a>
<FONT color="green">661</FONT>         * Tests whether a line is a comment, i.e. whether it starts with a comment<a name="line.661"></a>
<FONT color="green">662</FONT>         * character.<a name="line.662"></a>
<FONT color="green">663</FONT>         *<a name="line.663"></a>
<FONT color="green">664</FONT>         * @param line the line<a name="line.664"></a>
<FONT color="green">665</FONT>         * @return a flag if this is a comment line<a name="line.665"></a>
<FONT color="green">666</FONT>         */<a name="line.666"></a>
<FONT color="green">667</FONT>        static boolean isCommentLine(String line)<a name="line.667"></a>
<FONT color="green">668</FONT>        {<a name="line.668"></a>
<FONT color="green">669</FONT>            return PropertiesConfiguration.isCommentLine(line);<a name="line.669"></a>
<FONT color="green">670</FONT>        }<a name="line.670"></a>
<FONT color="green">671</FONT>    <a name="line.671"></a>
<FONT color="green">672</FONT>        /**<a name="line.672"></a>
<FONT color="green">673</FONT>         * Trims a comment. This method either removes all comment characters from<a name="line.673"></a>
<FONT color="green">674</FONT>         * the given string, leaving only the plain comment text or ensures that<a name="line.674"></a>
<FONT color="green">675</FONT>         * every line starts with a valid comment character.<a name="line.675"></a>
<FONT color="green">676</FONT>         *<a name="line.676"></a>
<FONT color="green">677</FONT>         * @param s the string to be processed<a name="line.677"></a>
<FONT color="green">678</FONT>         * @param comment if &lt;b&gt;true&lt;/b&gt;, a comment character will always be<a name="line.678"></a>
<FONT color="green">679</FONT>         * enforced; if &lt;b&gt;false&lt;/b&gt;, it will be removed<a name="line.679"></a>
<FONT color="green">680</FONT>         * @return the trimmed comment<a name="line.680"></a>
<FONT color="green">681</FONT>         */<a name="line.681"></a>
<FONT color="green">682</FONT>        static String trimComment(String s, boolean comment)<a name="line.682"></a>
<FONT color="green">683</FONT>        {<a name="line.683"></a>
<FONT color="green">684</FONT>            StringBuilder buf = new StringBuilder(s.length());<a name="line.684"></a>
<FONT color="green">685</FONT>            int lastPos = 0;<a name="line.685"></a>
<FONT color="green">686</FONT>            int pos;<a name="line.686"></a>
<FONT color="green">687</FONT>    <a name="line.687"></a>
<FONT color="green">688</FONT>            do<a name="line.688"></a>
<FONT color="green">689</FONT>            {<a name="line.689"></a>
<FONT color="green">690</FONT>                pos = s.indexOf(CR, lastPos);<a name="line.690"></a>
<FONT color="green">691</FONT>                if (pos &gt;= 0)<a name="line.691"></a>
<FONT color="green">692</FONT>                {<a name="line.692"></a>
<FONT color="green">693</FONT>                    String line = s.substring(lastPos, pos);<a name="line.693"></a>
<FONT color="green">694</FONT>                    buf.append(stripCommentChar(line, comment)).append(CR);<a name="line.694"></a>
<FONT color="green">695</FONT>                    lastPos = pos + CR.length();<a name="line.695"></a>
<FONT color="green">696</FONT>                }<a name="line.696"></a>
<FONT color="green">697</FONT>            } while (pos &gt;= 0);<a name="line.697"></a>
<FONT color="green">698</FONT>    <a name="line.698"></a>
<FONT color="green">699</FONT>            if (lastPos &lt; s.length())<a name="line.699"></a>
<FONT color="green">700</FONT>            {<a name="line.700"></a>
<FONT color="green">701</FONT>                buf.append(stripCommentChar(s.substring(lastPos), comment));<a name="line.701"></a>
<FONT color="green">702</FONT>            }<a name="line.702"></a>
<FONT color="green">703</FONT>            return buf.toString();<a name="line.703"></a>
<FONT color="green">704</FONT>        }<a name="line.704"></a>
<FONT color="green">705</FONT>    <a name="line.705"></a>
<FONT color="green">706</FONT>        /**<a name="line.706"></a>
<FONT color="green">707</FONT>         * Either removes the comment character from the given comment line or<a name="line.707"></a>
<FONT color="green">708</FONT>         * ensures that the line starts with a comment character.<a name="line.708"></a>
<FONT color="green">709</FONT>         *<a name="line.709"></a>
<FONT color="green">710</FONT>         * @param s the comment line<a name="line.710"></a>
<FONT color="green">711</FONT>         * @param comment if &lt;b&gt;true&lt;/b&gt;, a comment character will always be<a name="line.711"></a>
<FONT color="green">712</FONT>         * enforced; if &lt;b&gt;false&lt;/b&gt;, it will be removed<a name="line.712"></a>
<FONT color="green">713</FONT>         * @return the line without comment character<a name="line.713"></a>
<FONT color="green">714</FONT>         */<a name="line.714"></a>
<FONT color="green">715</FONT>        static String stripCommentChar(String s, boolean comment)<a name="line.715"></a>
<FONT color="green">716</FONT>        {<a name="line.716"></a>
<FONT color="green">717</FONT>            if (s.length() &lt; 1 || (isCommentLine(s) == comment))<a name="line.717"></a>
<FONT color="green">718</FONT>            {<a name="line.718"></a>
<FONT color="green">719</FONT>                return s;<a name="line.719"></a>
<FONT color="green">720</FONT>            }<a name="line.720"></a>
<FONT color="green">721</FONT>    <a name="line.721"></a>
<FONT color="green">722</FONT>            else<a name="line.722"></a>
<FONT color="green">723</FONT>            {<a name="line.723"></a>
<FONT color="green">724</FONT>                if (!comment)<a name="line.724"></a>
<FONT color="green">725</FONT>                {<a name="line.725"></a>
<FONT color="green">726</FONT>                    int pos = 0;<a name="line.726"></a>
<FONT color="green">727</FONT>                    // find first comment character<a name="line.727"></a>
<FONT color="green">728</FONT>                    while (PropertiesConfiguration.COMMENT_CHARS.indexOf(s<a name="line.728"></a>
<FONT color="green">729</FONT>                            .charAt(pos)) &lt; 0)<a name="line.729"></a>
<FONT color="green">730</FONT>                    {<a name="line.730"></a>
<FONT color="green">731</FONT>                        pos++;<a name="line.731"></a>
<FONT color="green">732</FONT>                    }<a name="line.732"></a>
<FONT color="green">733</FONT>    <a name="line.733"></a>
<FONT color="green">734</FONT>                    // Remove leading spaces<a name="line.734"></a>
<FONT color="green">735</FONT>                    pos++;<a name="line.735"></a>
<FONT color="green">736</FONT>                    while (pos &lt; s.length()<a name="line.736"></a>
<FONT color="green">737</FONT>                            &amp;&amp; Character.isWhitespace(s.charAt(pos)))<a name="line.737"></a>
<FONT color="green">738</FONT>                    {<a name="line.738"></a>
<FONT color="green">739</FONT>                        pos++;<a name="line.739"></a>
<FONT color="green">740</FONT>                    }<a name="line.740"></a>
<FONT color="green">741</FONT>    <a name="line.741"></a>
<FONT color="green">742</FONT>                    return (pos &lt; s.length()) ? s.substring(pos)<a name="line.742"></a>
<FONT color="green">743</FONT>                            : StringUtils.EMPTY;<a name="line.743"></a>
<FONT color="green">744</FONT>                }<a name="line.744"></a>
<FONT color="green">745</FONT>                else<a name="line.745"></a>
<FONT color="green">746</FONT>                {<a name="line.746"></a>
<FONT color="green">747</FONT>                    return COMMENT_PREFIX + s;<a name="line.747"></a>
<FONT color="green">748</FONT>                }<a name="line.748"></a>
<FONT color="green">749</FONT>            }<a name="line.749"></a>
<FONT color="green">750</FONT>        }<a name="line.750"></a>
<FONT color="green">751</FONT>    <a name="line.751"></a>
<FONT color="green">752</FONT>        /**<a name="line.752"></a>
<FONT color="green">753</FONT>         * Extracts a comment string from the given range of the specified comment<a name="line.753"></a>
<FONT color="green">754</FONT>         * lines. The single lines are added using a line feed as separator.<a name="line.754"></a>
<FONT color="green">755</FONT>         *<a name="line.755"></a>
<FONT color="green">756</FONT>         * @param commentLines a list with comment lines<a name="line.756"></a>
<FONT color="green">757</FONT>         * @param from the start index<a name="line.757"></a>
<FONT color="green">758</FONT>         * @param to the end index (inclusive)<a name="line.758"></a>
<FONT color="green">759</FONT>         * @return the comment string (&lt;b&gt;null&lt;/b&gt; if it is undefined)<a name="line.759"></a>
<FONT color="green">760</FONT>         */<a name="line.760"></a>
<FONT color="green">761</FONT>        private String extractComment(List&lt;String&gt; commentLines, int from, int to)<a name="line.761"></a>
<FONT color="green">762</FONT>        {<a name="line.762"></a>
<FONT color="green">763</FONT>            if (to &lt; from)<a name="line.763"></a>
<FONT color="green">764</FONT>            {<a name="line.764"></a>
<FONT color="green">765</FONT>                return null;<a name="line.765"></a>
<FONT color="green">766</FONT>            }<a name="line.766"></a>
<FONT color="green">767</FONT>    <a name="line.767"></a>
<FONT color="green">768</FONT>            else<a name="line.768"></a>
<FONT color="green">769</FONT>            {<a name="line.769"></a>
<FONT color="green">770</FONT>                StringBuilder buf = new StringBuilder(commentLines.get(from));<a name="line.770"></a>
<FONT color="green">771</FONT>                for (int i = from + 1; i &lt;= to; i++)<a name="line.771"></a>
<FONT color="green">772</FONT>                {<a name="line.772"></a>
<FONT color="green">773</FONT>                    buf.append(CR);<a name="line.773"></a>
<FONT color="green">774</FONT>                    buf.append(commentLines.get(i));<a name="line.774"></a>
<FONT color="green">775</FONT>                }<a name="line.775"></a>
<FONT color="green">776</FONT>                return buf.toString();<a name="line.776"></a>
<FONT color="green">777</FONT>            }<a name="line.777"></a>
<FONT color="green">778</FONT>        }<a name="line.778"></a>
<FONT color="green">779</FONT>    <a name="line.779"></a>
<FONT color="green">780</FONT>        /**<a name="line.780"></a>
<FONT color="green">781</FONT>         * Checks if parts of the passed in comment can be used as header comment.<a name="line.781"></a>
<FONT color="green">782</FONT>         * This method checks whether a header comment can be defined (i.e. whether<a name="line.782"></a>
<FONT color="green">783</FONT>         * this is the first comment in the loaded file). If this is the case, it is<a name="line.783"></a>
<FONT color="green">784</FONT>         * searched for the latest blanc line. This line will mark the end of the<a name="line.784"></a>
<FONT color="green">785</FONT>         * header comment. The return value is the index of the first line in the<a name="line.785"></a>
<FONT color="green">786</FONT>         * passed in list, which does not belong to the header comment.<a name="line.786"></a>
<FONT color="green">787</FONT>         *<a name="line.787"></a>
<FONT color="green">788</FONT>         * @param commentLines the comment lines<a name="line.788"></a>
<FONT color="green">789</FONT>         * @return the index of the next line after the header comment<a name="line.789"></a>
<FONT color="green">790</FONT>         */<a name="line.790"></a>
<FONT color="green">791</FONT>        private int checkHeaderComment(List&lt;String&gt; commentLines)<a name="line.791"></a>
<FONT color="green">792</FONT>        {<a name="line.792"></a>
<FONT color="green">793</FONT>            if (loadCounter == 1 &amp;&amp; getHeaderComment() == null<a name="line.793"></a>
<FONT color="green">794</FONT>                    &amp;&amp; layoutData.isEmpty())<a name="line.794"></a>
<FONT color="green">795</FONT>            {<a name="line.795"></a>
<FONT color="green">796</FONT>                // This is the first comment. Search for blanc lines.<a name="line.796"></a>
<FONT color="green">797</FONT>                int index = commentLines.size() - 1;<a name="line.797"></a>
<FONT color="green">798</FONT>                while (index &gt;= 0<a name="line.798"></a>
<FONT color="green">799</FONT>                        &amp;&amp; commentLines.get(index).length() &gt; 0)<a name="line.799"></a>
<FONT color="green">800</FONT>                {<a name="line.800"></a>
<FONT color="green">801</FONT>                    index--;<a name="line.801"></a>
<FONT color="green">802</FONT>                }<a name="line.802"></a>
<FONT color="green">803</FONT>                setHeaderComment(extractComment(commentLines, 0, index - 1));<a name="line.803"></a>
<FONT color="green">804</FONT>                return index + 1;<a name="line.804"></a>
<FONT color="green">805</FONT>            }<a name="line.805"></a>
<FONT color="green">806</FONT>            else<a name="line.806"></a>
<FONT color="green">807</FONT>            {<a name="line.807"></a>
<FONT color="green">808</FONT>                return 0;<a name="line.808"></a>
<FONT color="green">809</FONT>            }<a name="line.809"></a>
<FONT color="green">810</FONT>        }<a name="line.810"></a>
<FONT color="green">811</FONT>    <a name="line.811"></a>
<FONT color="green">812</FONT>        /**<a name="line.812"></a>
<FONT color="green">813</FONT>         * Copies the data from the given layout object.<a name="line.813"></a>
<FONT color="green">814</FONT>         *<a name="line.814"></a>
<FONT color="green">815</FONT>         * @param c the layout object to copy<a name="line.815"></a>
<FONT color="green">816</FONT>         */<a name="line.816"></a>
<FONT color="green">817</FONT>        private void copyFrom(PropertiesConfigurationLayout c)<a name="line.817"></a>
<FONT color="green">818</FONT>        {<a name="line.818"></a>
<FONT color="green">819</FONT>            for (String key : c.getKeys())<a name="line.819"></a>
<FONT color="green">820</FONT>            {<a name="line.820"></a>
<FONT color="green">821</FONT>                PropertyLayoutData data = c.layoutData.get(key);<a name="line.821"></a>
<FONT color="green">822</FONT>                layoutData.put(key, data.clone());<a name="line.822"></a>
<FONT color="green">823</FONT>            }<a name="line.823"></a>
<FONT color="green">824</FONT>        }<a name="line.824"></a>
<FONT color="green">825</FONT>    <a name="line.825"></a>
<FONT color="green">826</FONT>        /**<a name="line.826"></a>
<FONT color="green">827</FONT>         * Helper method for writing a comment line. This method ensures that the<a name="line.827"></a>
<FONT color="green">828</FONT>         * correct line separator is used if the comment spans multiple lines.<a name="line.828"></a>
<FONT color="green">829</FONT>         *<a name="line.829"></a>
<FONT color="green">830</FONT>         * @param writer the writer<a name="line.830"></a>
<FONT color="green">831</FONT>         * @param comment the comment to write<a name="line.831"></a>
<FONT color="green">832</FONT>         * @throws IOException if an IO error occurs<a name="line.832"></a>
<FONT color="green">833</FONT>         */<a name="line.833"></a>
<FONT color="green">834</FONT>        private static void writeComment(<a name="line.834"></a>
<FONT color="green">835</FONT>                PropertiesConfiguration.PropertiesWriter writer, String comment)<a name="line.835"></a>
<FONT color="green">836</FONT>                throws IOException<a name="line.836"></a>
<FONT color="green">837</FONT>        {<a name="line.837"></a>
<FONT color="green">838</FONT>            if (comment != null)<a name="line.838"></a>
<FONT color="green">839</FONT>            {<a name="line.839"></a>
<FONT color="green">840</FONT>                writer.writeln(StringUtils.replace(comment, CR, writer<a name="line.840"></a>
<FONT color="green">841</FONT>                        .getLineSeparator()));<a name="line.841"></a>
<FONT color="green">842</FONT>            }<a name="line.842"></a>
<FONT color="green">843</FONT>        }<a name="line.843"></a>
<FONT color="green">844</FONT>    <a name="line.844"></a>
<FONT color="green">845</FONT>        /**<a name="line.845"></a>
<FONT color="green">846</FONT>         * A helper class for storing all layout related information for a<a name="line.846"></a>
<FONT color="green">847</FONT>         * configuration property.<a name="line.847"></a>
<FONT color="green">848</FONT>         */<a name="line.848"></a>
<FONT color="green">849</FONT>        static class PropertyLayoutData implements Cloneable<a name="line.849"></a>
<FONT color="green">850</FONT>        {<a name="line.850"></a>
<FONT color="green">851</FONT>            /** Stores the comment for the property. */<a name="line.851"></a>
<FONT color="green">852</FONT>            private StringBuffer comment;<a name="line.852"></a>
<FONT color="green">853</FONT>    <a name="line.853"></a>
<FONT color="green">854</FONT>            /** The separator to be used for this property. */<a name="line.854"></a>
<FONT color="green">855</FONT>            private String separator;<a name="line.855"></a>
<FONT color="green">856</FONT>    <a name="line.856"></a>
<FONT color="green">857</FONT>            /** Stores the number of blanc lines before this property. */<a name="line.857"></a>
<FONT color="green">858</FONT>            private int blancLines;<a name="line.858"></a>
<FONT color="green">859</FONT>    <a name="line.859"></a>
<FONT color="green">860</FONT>            /** Stores the single line property. */<a name="line.860"></a>
<FONT color="green">861</FONT>            private boolean singleLine;<a name="line.861"></a>
<FONT color="green">862</FONT>    <a name="line.862"></a>
<FONT color="green">863</FONT>            /**<a name="line.863"></a>
<FONT color="green">864</FONT>             * Creates a new instance of {@code PropertyLayoutData}.<a name="line.864"></a>
<FONT color="green">865</FONT>             */<a name="line.865"></a>
<FONT color="green">866</FONT>            public PropertyLayoutData()<a name="line.866"></a>
<FONT color="green">867</FONT>            {<a name="line.867"></a>
<FONT color="green">868</FONT>                singleLine = true;<a name="line.868"></a>
<FONT color="green">869</FONT>                separator = PropertiesConfiguration.DEFAULT_SEPARATOR;<a name="line.869"></a>
<FONT color="green">870</FONT>            }<a name="line.870"></a>
<FONT color="green">871</FONT>    <a name="line.871"></a>
<FONT color="green">872</FONT>            /**<a name="line.872"></a>
<FONT color="green">873</FONT>             * Returns the number of blanc lines before this property.<a name="line.873"></a>
<FONT color="green">874</FONT>             *<a name="line.874"></a>
<FONT color="green">875</FONT>             * @return the number of blanc lines before this property<a name="line.875"></a>
<FONT color="green">876</FONT>             */<a name="line.876"></a>
<FONT color="green">877</FONT>            public int getBlancLines()<a name="line.877"></a>
<FONT color="green">878</FONT>            {<a name="line.878"></a>
<FONT color="green">879</FONT>                return blancLines;<a name="line.879"></a>
<FONT color="green">880</FONT>            }<a name="line.880"></a>
<FONT color="green">881</FONT>    <a name="line.881"></a>
<FONT color="green">882</FONT>            /**<a name="line.882"></a>
<FONT color="green">883</FONT>             * Sets the number of properties before this property.<a name="line.883"></a>
<FONT color="green">884</FONT>             *<a name="line.884"></a>
<FONT color="green">885</FONT>             * @param blancLines the number of properties before this property<a name="line.885"></a>
<FONT color="green">886</FONT>             */<a name="line.886"></a>
<FONT color="green">887</FONT>            public void setBlancLines(int blancLines)<a name="line.887"></a>
<FONT color="green">888</FONT>            {<a name="line.888"></a>
<FONT color="green">889</FONT>                this.blancLines = blancLines;<a name="line.889"></a>
<FONT color="green">890</FONT>            }<a name="line.890"></a>
<FONT color="green">891</FONT>    <a name="line.891"></a>
<FONT color="green">892</FONT>            /**<a name="line.892"></a>
<FONT color="green">893</FONT>             * Returns the single line flag.<a name="line.893"></a>
<FONT color="green">894</FONT>             *<a name="line.894"></a>
<FONT color="green">895</FONT>             * @return the single line flag<a name="line.895"></a>
<FONT color="green">896</FONT>             */<a name="line.896"></a>
<FONT color="green">897</FONT>            public boolean isSingleLine()<a name="line.897"></a>
<FONT color="green">898</FONT>            {<a name="line.898"></a>
<FONT color="green">899</FONT>                return singleLine;<a name="line.899"></a>
<FONT color="green">900</FONT>            }<a name="line.900"></a>
<FONT color="green">901</FONT>    <a name="line.901"></a>
<FONT color="green">902</FONT>            /**<a name="line.902"></a>
<FONT color="green">903</FONT>             * Sets the single line flag.<a name="line.903"></a>
<FONT color="green">904</FONT>             *<a name="line.904"></a>
<FONT color="green">905</FONT>             * @param singleLine the single line flag<a name="line.905"></a>
<FONT color="green">906</FONT>             */<a name="line.906"></a>
<FONT color="green">907</FONT>            public void setSingleLine(boolean singleLine)<a name="line.907"></a>
<FONT color="green">908</FONT>            {<a name="line.908"></a>
<FONT color="green">909</FONT>                this.singleLine = singleLine;<a name="line.909"></a>
<FONT color="green">910</FONT>            }<a name="line.910"></a>
<FONT color="green">911</FONT>    <a name="line.911"></a>
<FONT color="green">912</FONT>            /**<a name="line.912"></a>
<FONT color="green">913</FONT>             * Adds a comment for this property. If already a comment exists, the<a name="line.913"></a>
<FONT color="green">914</FONT>             * new comment is added (separated by a newline).<a name="line.914"></a>
<FONT color="green">915</FONT>             *<a name="line.915"></a>
<FONT color="green">916</FONT>             * @param s the comment to add<a name="line.916"></a>
<FONT color="green">917</FONT>             */<a name="line.917"></a>
<FONT color="green">918</FONT>            public void addComment(String s)<a name="line.918"></a>
<FONT color="green">919</FONT>            {<a name="line.919"></a>
<FONT color="green">920</FONT>                if (s != null)<a name="line.920"></a>
<FONT color="green">921</FONT>                {<a name="line.921"></a>
<FONT color="green">922</FONT>                    if (comment == null)<a name="line.922"></a>
<FONT color="green">923</FONT>                    {<a name="line.923"></a>
<FONT color="green">924</FONT>                        comment = new StringBuffer(s);<a name="line.924"></a>
<FONT color="green">925</FONT>                    }<a name="line.925"></a>
<FONT color="green">926</FONT>                    else<a name="line.926"></a>
<FONT color="green">927</FONT>                    {<a name="line.927"></a>
<FONT color="green">928</FONT>                        comment.append(CR).append(s);<a name="line.928"></a>
<FONT color="green">929</FONT>                    }<a name="line.929"></a>
<FONT color="green">930</FONT>                }<a name="line.930"></a>
<FONT color="green">931</FONT>            }<a name="line.931"></a>
<FONT color="green">932</FONT>    <a name="line.932"></a>
<FONT color="green">933</FONT>            /**<a name="line.933"></a>
<FONT color="green">934</FONT>             * Sets the comment for this property.<a name="line.934"></a>
<FONT color="green">935</FONT>             *<a name="line.935"></a>
<FONT color="green">936</FONT>             * @param s the new comment (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.936"></a>
<FONT color="green">937</FONT>             */<a name="line.937"></a>
<FONT color="green">938</FONT>            public void setComment(String s)<a name="line.938"></a>
<FONT color="green">939</FONT>            {<a name="line.939"></a>
<FONT color="green">940</FONT>                if (s == null)<a name="line.940"></a>
<FONT color="green">941</FONT>                {<a name="line.941"></a>
<FONT color="green">942</FONT>                    comment = null;<a name="line.942"></a>
<FONT color="green">943</FONT>                }<a name="line.943"></a>
<FONT color="green">944</FONT>                else<a name="line.944"></a>
<FONT color="green">945</FONT>                {<a name="line.945"></a>
<FONT color="green">946</FONT>                    comment = new StringBuffer(s);<a name="line.946"></a>
<FONT color="green">947</FONT>                }<a name="line.947"></a>
<FONT color="green">948</FONT>            }<a name="line.948"></a>
<FONT color="green">949</FONT>    <a name="line.949"></a>
<FONT color="green">950</FONT>            /**<a name="line.950"></a>
<FONT color="green">951</FONT>             * Returns the comment for this property. The comment is returned as it<a name="line.951"></a>
<FONT color="green">952</FONT>             * is, without processing of comment characters.<a name="line.952"></a>
<FONT color="green">953</FONT>             *<a name="line.953"></a>
<FONT color="green">954</FONT>             * @return the comment (can be &lt;b&gt;null&lt;/b&gt;)<a name="line.954"></a>
<FONT color="green">955</FONT>             */<a name="line.955"></a>
<FONT color="green">956</FONT>            public String getComment()<a name="line.956"></a>
<FONT color="green">957</FONT>            {<a name="line.957"></a>
<FONT color="green">958</FONT>                return (comment == null) ? null : comment.toString();<a name="line.958"></a>
<FONT color="green">959</FONT>            }<a name="line.959"></a>
<FONT color="green">960</FONT>    <a name="line.960"></a>
<FONT color="green">961</FONT>            /**<a name="line.961"></a>
<FONT color="green">962</FONT>             * Returns the separator that was used for this property.<a name="line.962"></a>
<FONT color="green">963</FONT>             *<a name="line.963"></a>
<FONT color="green">964</FONT>             * @return the property separator<a name="line.964"></a>
<FONT color="green">965</FONT>             */<a name="line.965"></a>
<FONT color="green">966</FONT>            public String getSeparator()<a name="line.966"></a>
<FONT color="green">967</FONT>            {<a name="line.967"></a>
<FONT color="green">968</FONT>                return separator;<a name="line.968"></a>
<FONT color="green">969</FONT>            }<a name="line.969"></a>
<FONT color="green">970</FONT>    <a name="line.970"></a>
<FONT color="green">971</FONT>            /**<a name="line.971"></a>
<FONT color="green">972</FONT>             * Sets the separator to be used for the represented property.<a name="line.972"></a>
<FONT color="green">973</FONT>             *<a name="line.973"></a>
<FONT color="green">974</FONT>             * @param separator the property separator<a name="line.974"></a>
<FONT color="green">975</FONT>             */<a name="line.975"></a>
<FONT color="green">976</FONT>            public void setSeparator(String separator)<a name="line.976"></a>
<FONT color="green">977</FONT>            {<a name="line.977"></a>
<FONT color="green">978</FONT>                this.separator = separator;<a name="line.978"></a>
<FONT color="green">979</FONT>            }<a name="line.979"></a>
<FONT color="green">980</FONT>    <a name="line.980"></a>
<FONT color="green">981</FONT>            /**<a name="line.981"></a>
<FONT color="green">982</FONT>             * Creates a copy of this object.<a name="line.982"></a>
<FONT color="green">983</FONT>             *<a name="line.983"></a>
<FONT color="green">984</FONT>             * @return the copy<a name="line.984"></a>
<FONT color="green">985</FONT>             */<a name="line.985"></a>
<FONT color="green">986</FONT>            @Override<a name="line.986"></a>
<FONT color="green">987</FONT>            public PropertyLayoutData clone()<a name="line.987"></a>
<FONT color="green">988</FONT>            {<a name="line.988"></a>
<FONT color="green">989</FONT>                try<a name="line.989"></a>
<FONT color="green">990</FONT>                {<a name="line.990"></a>
<FONT color="green">991</FONT>                    PropertyLayoutData copy = (PropertyLayoutData) super.clone();<a name="line.991"></a>
<FONT color="green">992</FONT>                    if (comment != null)<a name="line.992"></a>
<FONT color="green">993</FONT>                    {<a name="line.993"></a>
<FONT color="green">994</FONT>                        // must copy string buffer, too<a name="line.994"></a>
<FONT color="green">995</FONT>                        copy.comment = new StringBuffer(getComment());<a name="line.995"></a>
<FONT color="green">996</FONT>                    }<a name="line.996"></a>
<FONT color="green">997</FONT>                    return copy;<a name="line.997"></a>
<FONT color="green">998</FONT>                }<a name="line.998"></a>
<FONT color="green">999</FONT>                catch (CloneNotSupportedException cnex)<a name="line.999"></a>
<FONT color="green">1000</FONT>                {<a name="line.1000"></a>
<FONT color="green">1001</FONT>                    // This cannot happen!<a name="line.1001"></a>
<FONT color="green">1002</FONT>                    throw new ConfigurationRuntimeException(cnex);<a name="line.1002"></a>
<FONT color="green">1003</FONT>                }<a name="line.1003"></a>
<FONT color="green">1004</FONT>            }<a name="line.1004"></a>
<FONT color="green">1005</FONT>        }<a name="line.1005"></a>
<FONT color="green">1006</FONT>    }<a name="line.1006"></a>




























































</PRE>
</BODY>
</HTML>
